ModelingTable

Table definition in a model, contains table schema, name, columns, etc.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

primaryKeyColumnUniqueName

Unique identifier of the primary key column of this table

-

string

isAggregatedTable

Is this table is an Aggregated table

-

boolean

modelingMeasures

List of measures in this table

-

ModelingMeasure [ ]

modelingTableType

Table type

-

ModelingTableType

displayName

The table's display name

-

string

modelingAggregationMappings

List of aggregated values in this aggregated table

-

ModelingAggregationMapping [ ]

syncColumnsWithDb

Defines whether to synchronize columns with DB columns.

-

boolean

description

The tables's description

-

string

isVisible

Visible in the relationship diagram

-

boolean

schemaName

Schema name in the source database

-

string

modelingColumns

List of columns in this table

-

ModelingColumn [ ]

sourceTableName

Tables name in the source database

-

string

uniqueName

Unique identifier of this table

-

string

translations

list of translations for table display name by language

-

MetaDataTranslation [ ]

tableSize

The number of rows in the table

-

integer

int64

isML

Is this table a telemetry ml table

-

boolean

measureGroups

List of measure group ids

-

string [ ]

tableId

The table's system ID

-

string

uuid

modelingHierarchies

List of hierarchies in this table

-

ModelingHierarchy [ ]

foldersTranslations

List of translations for each folder display name in the model.

-

ModelingFolderTranslations [ ]

customQuery

If this tables is based on a query, instead of schema and table name

-

string